Doc additions.

2004-11-02  Matthias Clasen  <mclasen@redhat.com>

	* gtk/gtkcellrenderercombo.c (gtk_cell_renderer_combo_class_init):
	Doc additions.

2004-11-02  Matthias Clasen  <mclasen@redhat.com>

	* gtk/tmpl/gtkcellrenderercombo.sgml:
	* gtk/tmpl/gtkcellrenderertoggle.sgml:
	* gtk/tmpl/gtkcellrenderertext.sgml: Add introductions.

	* gtk/tmpl/gtkcellrenderer.sgml: Additions.

diff --git a/ChangeLog b/ChangeLog
index 595c428e1cddce2aa5cf7bf205cc637e8b1713eb..4b564ba8fd43de0d28043abc0f8861eb37b08c86 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,8 @@
 2004-11-02  Matthias Clasen  <mclasen@redhat.com>
 
+       * gtk/gtkcellrenderercombo.c (gtk_cell_renderer_combo_class_init): 
+       Doc additions.
+
        * gtk/gtkfilechooserbutton.h: Fix trigraphs in private markers.
 
        * gtk/gtkfilechooserbutton.c (gtk_file_chooser_button_class_init): 

diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10
index 595c428e1cddce2aa5cf7bf205cc637e8b1713eb..4b564ba8fd43de0d28043abc0f8861eb37b08c86 100644 (file)
--- a/ChangeLog.pre-2-10
+++ b/ChangeLog.pre-2-10
@@ -1,5 +1,8 @@
 2004-11-02  Matthias Clasen  <mclasen@redhat.com>
 
+       * gtk/gtkcellrenderercombo.c (gtk_cell_renderer_combo_class_init): 
+       Doc additions.
+
        * gtk/gtkfilechooserbutton.h: Fix trigraphs in private markers.
 
        * gtk/gtkfilechooserbutton.c (gtk_file_chooser_button_class_init): 

diff --git a/ChangeLog.pre-2-6 b/ChangeLog.pre-2-6
index 595c428e1cddce2aa5cf7bf205cc637e8b1713eb..4b564ba8fd43de0d28043abc0f8861eb37b08c86 100644 (file)
--- a/ChangeLog.pre-2-6
+++ b/ChangeLog.pre-2-6
@@ -1,5 +1,8 @@
 2004-11-02  Matthias Clasen  <mclasen@redhat.com>
 
+       * gtk/gtkcellrenderercombo.c (gtk_cell_renderer_combo_class_init): 
+       Doc additions.
+
        * gtk/gtkfilechooserbutton.h: Fix trigraphs in private markers.
 
        * gtk/gtkfilechooserbutton.c (gtk_file_chooser_button_class_init): 

diff --git a/ChangeLog.pre-2-8 b/ChangeLog.pre-2-8
index 595c428e1cddce2aa5cf7bf205cc637e8b1713eb..4b564ba8fd43de0d28043abc0f8861eb37b08c86 100644 (file)
--- a/ChangeLog.pre-2-8
+++ b/ChangeLog.pre-2-8
@@ -1,5 +1,8 @@
 2004-11-02  Matthias Clasen  <mclasen@redhat.com>
 
+       * gtk/gtkcellrenderercombo.c (gtk_cell_renderer_combo_class_init): 
+       Doc additions.
+
        * gtk/gtkfilechooserbutton.h: Fix trigraphs in private markers.
 
        * gtk/gtkfilechooserbutton.c (gtk_file_chooser_button_class_init): 

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index a8e95fd19bda16231a89d9688d5c156f2bd09ec1..cf4d3e9c4c865fe554cff12e498863f5305c7c38 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,5 +1,11 @@
 2004-11-02  Matthias Clasen  <mclasen@redhat.com>
 
+       * gtk/tmpl/gtkcellrenderercombo.sgml: 
+       * gtk/tmpl/gtkcellrenderertoggle.sgml: 
+       * gtk/tmpl/gtkcellrenderertext.sgml: Add introductions.
+       
+       * gtk/tmpl/gtkcellrenderer.sgml: Additions.
+
        * gtk/gtk-sections.txt: Remove GtkFileChooserEmbed, since
        it is not in the headers we parse.
 

diff --git a/docs/reference/gtk/tmpl/gtkcellrenderer.sgml b/docs/reference/gtk/tmpl/gtkcellrenderer.sgml
index 47d16ece1ea2f2d2a08d39e805790edc15b122d2..fc27be321bb71cf9ae1b8f90729adc6ec7c2ace3 100644 (file)
--- a/docs/reference/gtk/tmpl/gtkcellrenderer.sgml
+++ b/docs/reference/gtk/tmpl/gtkcellrenderer.sgml
@@ -19,8 +19,8 @@ elements on a #GdkDrawable.  Typically, one cell renderer is used to
 draw many cells on the screen.  To this extent, it isn't expected that a
 CellRenderer keep any permanent state around.  Instead, any state is set
 just prior to use using #GObject<!-- -->s property system.  Then, the
-cell is measured using @gtk_cell_renderer_get_size.  Finally, the cell
-is rendered in the correct location using @gtk_cell_renderer_render.
+cell is measured using gtk_cell_renderer_get_size().  Finally, the cell
+is rendered in the correct location using gtk_cell_renderer_render().
 </para>
 
 <para>
@@ -31,6 +31,17 @@ barring a #GtkStyle change.  The #GtkCellRenderer also has a number of
 generic properties that are expected to be honored by all children.
 </para>
 
+<para>
+Beyond merely rendering a cell, cell renderers can optionally 
+provide active user interface elements. A cell renderer can be 
+<firstterm>activatable</firstterm> like #GtkCellRendererToggle, 
+which toggles when it gets activated by a mouse click, or it can be 
+<firstterm>editable</firstterm> like #GtkCellRendererText, which 
+allows the user to edit the text using a #GtkEntry.
+To make a cell renderer activatable or editable, you have to 
+implement the @activate or @start_editing virtual functions, 
+respectively.
+</para>
 <!-- ##### SECTION See_Also ##### -->
 <para>
 #GtkCellRendererText,#GtkCellRendererPixbuf,#GtkCellRendererToggle

diff --git a/docs/reference/gtk/tmpl/gtkcellrenderercombo.sgml b/docs/reference/gtk/tmpl/gtkcellrenderercombo.sgml
index e0353c1119a381ae72335a34f8f78dccba87f77e..fa9490e7e9a9d0292014764a439a8a6edc1e7764 100644 (file)
--- a/docs/reference/gtk/tmpl/gtkcellrenderercombo.sgml
+++ b/docs/reference/gtk/tmpl/gtkcellrenderercombo.sgml
@@ -2,11 +2,22 @@
 GtkCellRendererCombo
 
 <!-- ##### SECTION Short_Description ##### -->
-
+Renders a combobox in a cell
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
+#GtkCellRendererCombo renders text in a cell like #GtkCellRendererText from which it
+is derived. But while #GtkCellRendererText offers a simple entry to edit the text,
+#GtkCellRendererCombo offers a #GtkComboBox or #GtkComboBoxEntry widget to edit 
+the text. The values to display in the combo box are taken from the tree model 
+specified in the <link linkend="GtkCellRendererCombo--model">model</link> property.
+</para>
 
+<para>
+The combo cell renderer takes care of adding a text cell renderer to the combo box
+and sets it to display the column specified by its 
+<link linkend="GtkCellRendererCombo--text-column">text-column</link> property. Further
+cell renderers can be added in a handler for the editing-started signal.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->

diff --git a/docs/reference/gtk/tmpl/gtkcellrendererpixbuf.sgml b/docs/reference/gtk/tmpl/gtkcellrendererpixbuf.sgml
index b574076f7035939a699fc2db8d6f4761e92e487d..7ff0da00d1cbc4f369fe2bbb61e80c7c23f840e1 100644 (file)
--- a/docs/reference/gtk/tmpl/gtkcellrendererpixbuf.sgml
+++ b/docs/reference/gtk/tmpl/gtkcellrendererpixbuf.sgml
@@ -7,20 +7,22 @@ Renders a pixbuf in a cell
 <!-- ##### SECTION Long_Description ##### -->
 <para>
 A #GtkCellRendererPixbuf can be used to render an image in a cell. It allows to render 
-either a given #GdkPixbuf (set via the <link linkend="GtkCellRendererPixbuf--pixbuf">pixbuf</link>
-property) or a stock icon (set via the <link linkend="GtkCellRendererPixbuf--stock-id">stock-id</link>
-property).
+either a given #GdkPixbuf (set via the 
+<link linkend="GtkCellRendererPixbuf--pixbuf">pixbuf</link> property) or a stock icon 
+(set via the <link linkend="GtkCellRendererPixbuf--stock-id">stock-id</link> property).
 </para>
 
 <para>
-To support the tree view, #GtkCellRendererPixbuf also supports rendering two alternative pixbufs,
-when the <link linkend="GtkCellRenderer--is-expander">is-expander</link> property is %TRUE.
-If the <link linkend="GtkCellRenderer--is-expander">is-expander</link> property is %TRUE and
-the <link linkend="GtkCellRendererPixbuf--pixbuf-expander-open">pixbuf-expander-open</link> property
-is set to a pixbuf, it renders that pixbuf, if the 
-<link linkend="GtkCellRenderer--is-expander">is-expander</link> property is %FALSE and
-the <link linkend="GtkCellRendererPixbuf--pixbuf-expander-closed">pixbuf-expander-closed</link> property
-is set to a pixbuf, it renders that one. 
+To support the tree view, #GtkCellRendererPixbuf also supports rendering two alternative 
+pixbufs, when the <link linkend="GtkCellRenderer--is-expander">is-expander</link> property 
+is %TRUE. If the <link linkend="GtkCellRenderer--is-expanded">is-expanded</link> property 
+is %TRUE and the 
+<link linkend="GtkCellRendererPixbuf--pixbuf-expander-open">pixbuf-expander-open</link> 
+property is set to a pixbuf, it renders that pixbuf, if the 
+<link linkend="GtkCellRenderer--is-expanded">is-expanded</link> property is %FALSE and
+the 
+<link linkend="GtkCellRendererPixbuf--pixbuf-expander-closed">pixbuf-expander-closed</link> 
+property is set to a pixbuf, it renders that one. 
 </para>
 
 <!-- ##### SECTION See_Also ##### -->

diff --git a/docs/reference/gtk/tmpl/gtkcellrenderertext.sgml b/docs/reference/gtk/tmpl/gtkcellrenderertext.sgml
index 572408a34dd46297833700dd75818836601d10df..1dcd31fc04be6b9647393ca06d230527b9bd41b6 100644 (file)
--- a/docs/reference/gtk/tmpl/gtkcellrenderertext.sgml
+++ b/docs/reference/gtk/tmpl/gtkcellrenderertext.sgml
@@ -6,7 +6,15 @@ Renders text in a cell
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
+A #GtkCellRendererText renders a given text in its cell, using the font, color and 
+style information provided by its properties. The text will be ellipsized if it is 
+too long and the <link linkend="GtkCellRendererText--ellipsize">ellipsize</link> 
+property allows it.
+</para>
 
+<para>
+If the <link linkend="GtkCellRenderer--mode">mode</link> is %GTK_CELL_RENDERER_MODE_EDITABLE,
+the #GtkCellRendererText allows to edit its text using an entry.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->

diff --git a/docs/reference/gtk/tmpl/gtkcellrenderertoggle.sgml b/docs/reference/gtk/tmpl/gtkcellrenderertoggle.sgml
index 12f75faf9d27379aa8e3b8ee04e39274b9a347b3..34c49b336a0a324a2fa904cf6fa6d622ad52d7e5 100644 (file)
--- a/docs/reference/gtk/tmpl/gtkcellrenderertoggle.sgml
+++ b/docs/reference/gtk/tmpl/gtkcellrenderertoggle.sgml
@@ -6,7 +6,10 @@ Renders a toggle button in a cell
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
-
+#GtkCellRendererToggle renders a toggle button in a cell. The 
+button is drawn as a radio- or checkbutton, depending on the 
+<link linkend="GtkCellRendererToggle--radio">radio</link> 
+property. When activated, it emits the toggled signal.
 </para>
 
 <!-- ##### SECTION See_Also ##### -->

diff --git a/gtk/gtkcellrenderercombo.c b/gtk/gtkcellrenderercombo.c
index f15bc7bad77f61f13db3a62f3a14d5fce3a02563..8b26a8d5554097945f6d3bb157c2bc85532d4cd9 100644 (file)
--- a/gtk/gtkcellrenderercombo.c
+++ b/gtk/gtkcellrenderercombo.c
@@ -98,6 +98,9 @@ gtk_cell_renderer_combo_class_init (GtkCellRendererComboClass *klass)
    * <emphasis>not</emphasis> the model backing the tree view to which this cell 
    * renderer is attached.
    * 
+   * #GtkCellRendererCombo automatically adds a text cell renderer for this column
+   * to its combo box.
+   *
    * Since: 2.6
    */
   g_object_class_install_property (object_class,
@@ -140,7 +143,7 @@ gtk_cell_renderer_combo_init (GtkCellRendererCombo *self)
 /**
  * gtk_cell_renderer_combo_new: 
  * 
- * Creates a new #GtkCellRendererCombo 
+ * Creates a new #GtkCellRendererCombo. 
  * Adjust how text is drawn using object properties. 
  * Object properties can be set globally (with g_object_set()). 
  * Also, with #GtkTreeViewColumn, you can bind a property to a value